/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.tom_roush.pdfbox.pdmodel.interactive.form;

import java.io.File;
import java.io.IOException;

import com.tom_roush.pdfbox.cos.COSName;
import com.tom_roush.pdfbox.cos.COSString;
import com.tom_roush.pdfbox.pdmodel.PDDocument;
import com.tom_roush.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget;

import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;

/**
 * This will test the form fields in PDFBox.
 *
 * @author Ben Litchfield
 */
public class TestFields extends TestCase
{
    private static final String PATH_OF_PDF = "src/test/resources/pdfbox/com/tom_roush/pdfbox/pdmodel/interactive/form/AcroFormsBasicFields.pdf";


    /**
     * Constructor.
     *
     * @param name The name of the test to run.
     */
    public TestFields( String name )
    {
        super( name );
    }

    /**
     * This will get the suite of test that this class holds.
     *
     * @return All of the tests that this class holds.
     */
    public static Test suite()
    {
        return new TestSuite( TestFields.class );
    }

    /**
     * infamous main method.
     *
     * @param args The command line arguments.
     */
    public static void main( String[] args )
    {
        String[] arg = {TestFields.class.getName() };
        junit.textui.TestRunner.main( arg );
    }

    /**
     * This will test setting field flags on the PDField.
     *
     * @throws IOException If there is an error creating the field.
     */
    public void testFlags() throws IOException
    {
        PDDocument doc = null;
        try
        {
            doc = new PDDocument();
            PDAcroForm form = new PDAcroForm( doc );
            PDTextField textBox = new PDTextField(form);

            //assert that default is false.
            assertFalse( textBox.isComb() );

            //try setting and clearing a single field
            textBox.setComb( true );
            assertTrue( textBox.isComb() );
            textBox.setComb( false );
            assertFalse( textBox.isComb() );

            //try setting and clearing multiple fields
            textBox.setComb( true );
            textBox.setDoNotScroll( true );
            assertTrue( textBox.isComb() );
            assertTrue( textBox.doNotScroll() );

            textBox.setComb( false );
            textBox.setDoNotScroll( false );
            assertFalse( textBox.isComb() );
            assertFalse( textBox.doNotScroll() );

            //assert that setting a field to false multiple times works
            textBox.setComb( false );
            assertFalse( textBox.isComb() );
            textBox.setComb( false );
            assertFalse( textBox.isComb() );

            //assert that setting a field to true multiple times works
            textBox.setComb( true );
            assertTrue( textBox.isComb() );
            textBox.setComb( true );
            assertTrue( textBox.isComb() );
        }
        finally
        {
            if( doc != null )
            {
                doc.close();
            }
        }
    }

    /**
     * This will test some form fields functionality based with 
     * a sample form.
     *
     * @throws IOException If there is an error creating the field.
     */
    public void testAcroFormsBasicFields() throws IOException
    {
        PDDocument doc = null;

        try
        {
            doc = PDDocument.load(new File(PATH_OF_PDF));

            // get and assert that there is a form
            PDAcroForm form = doc.getDocumentCatalog().getAcroForm();
            assertNotNull(form);

            // assert that there is no value, set the field value and
            // ensure it has been set 
            PDTextField textField = (PDTextField)form.getField("TextField");
            assertNull(textField.getCOSObject().getItem(COSName.V));
            textField.setValue("field value");
            assertNotNull(textField.getCOSObject().getItem(COSName.V));
            assertEquals(textField.getValue(),"field value");

            // assert when setting to null the key has also been removed
            assertNotNull(textField.getCOSObject().getItem(COSName.V));
            textField.setValue(null);
            assertNull(textField.getCOSObject().getItem(COSName.V));

            // get the TextField with a DV entry
            textField = (PDTextField)form.getField("TextField-DefaultValue");
            assertNotNull(textField);
            assertEquals(textField.getDefaultValue(),"DefaultValue");
            assertEquals(textField.getDefaultValue(),
                ((COSString)textField.getCOSObject().getDictionaryObject(COSName.DV)).getString());
            assertEquals(textField.getDefaultAppearance(),"/Helv 12 Tf 0 g");

            // get a rich text field with a  DV entry
            textField = (PDTextField)form.getField("RichTextField-DefaultValue");
            assertNotNull(textField);
            assertEquals(textField.getDefaultValue(),"DefaultValue");
            assertEquals(textField.getDefaultValue(),
                ((COSString)textField.getCOSObject().getDictionaryObject(COSName.DV)).getString());
            assertEquals(textField.getValue(), "DefaultValue");
            assertEquals(textField.getDefaultAppearance(), "/Helv 12 Tf 0 g");
            assertEquals(textField.getDefaultStyleString(),
                "font: Helvetica,sans-serif 12.0pt; text-align:left; color:#000000 ");
            // do not test for the full content as this is a rather long xml string
            assertEquals(textField.getRichTextValue().length(),338);

            // get a rich text field with a text stream for the value
            textField = (PDTextField)form.getField("LongRichTextField");
            assertNotNull(textField);
            assertEquals(textField.getCOSObject().getDictionaryObject(
                COSName.V).getClass().getName(),
                "com.tom_roush.pdfbox.cos.COSStream");
            assertEquals(textField.getValue().length(),145396);

        }
        finally
        {
            if( doc != null )
            {
                doc.close();
            }
        }
    }

    /**
     * This will test the handling of a widget with a missing (required) /Rect entry.
     *
     * @throws IOException If there is an error loading the form or the field.
     */
    public void testWidgetMissingRect() throws IOException
    {
        PDDocument doc = null;

        try
        {
            doc = PDDocument.load(new File(PATH_OF_PDF));

            PDAcroForm form = doc.getDocumentCatalog().getAcroForm();

            PDTextField textField = (PDTextField)form.getField("TextField-DefaultValue");
            PDAnnotationWidget widget = textField.getWidgets().get(0);

            // initially there is an Appearance Entry in the form
            assertNotNull(widget.getCOSObject().getDictionaryObject(COSName.AP));
            widget.getCOSObject().removeItem(COSName.RECT);
            textField.setValue("field value");

            // There shall be no appearance entry if there is no /Rect to
            // behave as Adobe Acrobat does
            assertNull(widget.getCOSObject().getDictionaryObject(COSName.AP));

        }
        finally
        {
            if( doc != null )
            {
                doc.close();
            }
        }
    }
}